<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<title>TurtleDB: ca.uqac.dim.turtledb.Engine Class Reference</title>

<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
</script>


</head>
<body>
<div id="top"><!-- do not remove this div! -->


<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  
  
  <td style="padding-left: 0.5em;">
   <div id="projectname">TurtleDB
   
   </div>
   <div id="projectbrief">A mini distributed database system</div>
  </td>
  
  
  
 </tr>
 </tbody>
</table>
</div>

<!-- Generated by Doxygen 1.7.6.1 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="namespaces.html"><span>Packages</span></a></li>
      <li class="current"><a href="annotated.html"><span>Classes</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Class&#160;List</span></a></li>
      <li><a href="classes.html"><span>Class&#160;Index</span></a></li>
      <li><a href="inherits.html"><span>Class&#160;Hierarchy</span></a></li>
      <li><a href="functions.html"><span>Class&#160;Members</span></a></li>
    </ul>
  </div>
</div>
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;" 
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
  initNavTree('classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html','');
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#pub-methods">Public Member Functions</a> &#124;
<a href="#pro-attribs">Protected Attributes</a>  </div>
  <div class="headertitle">
<div class="title">ca.uqac.dim.turtledb.Engine Class Reference</div>  </div>
</div><!--header-->
<div class="contents">
<!-- doxytag: class="ca::uqac::dim::turtledb::Engine" --><div class="dynheader">
Collaboration diagram for ca.uqac.dim.turtledb.Engine:</div>
<div class="dyncontent">
<div class="center"><img src="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine__coll__graph.png" border="0" usemap="#ca_8uqac_8dim_8turtledb_8_engine_coll__map" alt="Collaboration graph"/></div>
<center><span class="legend">[<a target="top" href="graph_legend.html">legend</a>]</span></center></div>

<p><a href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine-members.html">List of all members.</a></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a2e327c6ae16bfdfd6f33a3bb2b316392">Engine</a> (String name)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae0151fa00d1f1bd56f1e22a9b4e554b1">putRelation</a> (String name, <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> r)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a69916ef536a8cc50b7963f698324b679">addQuery</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> query)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a75d87c32bedf11ceaaf4aabcaa3d4bb5">addQuery</a> (Collection&lt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> &gt; queries)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Set&lt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a0875d6d4fa02325381018551d28bbdf4">processPendingQueries</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_query_plan.html">QueryPlan</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#acb1c919eba2627b81af6038737a2e693">getQueryPlan</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> query)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae9740e5e82e1c0a27d2f776d5f94e9c5">evaluate</a> (<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> query)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a313f75b83903774366501e0263c583fc">evaluate</a> (String s)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a5e51f3ae0cbf374ef1f964e74cb2d165">evaluate</a> (Document d)</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#afe382772677f32c01e99491546bb92c7">getStorageSize</a> ()</td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a0f1f2a11d6134baab599777810cb8ab3">getTuplesReceived</a> ()</td></tr>
<tr><td colspan="2"><h2><a name="pro-attribs"></a>
Protected Attributes</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">Map&lt; String, <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#abe4f2a3c91bb50dd8eae920fc4f70b7a">m_tables</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">List&lt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> &gt;&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#acd0ede62f32f128788ebece4966a09ea">m_pendingQueries</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a324ad5477ac8645f31483a7e4b493e21">m_numTuplesReceived</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">String&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae2dbc25a1e13d2b649b58db1420a3c55">m_siteName</a></td></tr>
</table>
<hr/><a name="details" id="details"></a><h2>Detailed Description</h2>
<div class="textblock"><p>An engine does two things: </p>
<ol>
<li>
It locally hosts relations (or fragments thereof) </li>
<li>
It receives relational query trees and evaluates them against the locally-hosted relations, then outputs the resulting relation </li>
</ol>
<dl class="author"><dt><b>Author:</b></dt><dd>sylvain </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00038">38</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>
</div><hr/><h2>Constructor &amp; Destructor Documentation</h2>
<a class="anchor" id="a2e327c6ae16bfdfd6f33a3bb2b316392"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::Engine" ref="a2e327c6ae16bfdfd6f33a3bb2b316392" args="(String name)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a2e327c6ae16bfdfd6f33a3bb2b316392">ca.uqac.dim.turtledb.Engine.Engine</a> </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>name</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Instantiates a new database query engine. </p>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00060">60</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<hr/><h2>Member Function Documentation</h2>
<a class="anchor" id="a69916ef536a8cc50b7963f698324b679"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::addQuery" ref="a69916ef536a8cc50b7963f698324b679" args="(Relation query)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a69916ef536a8cc50b7963f698324b679">ca.uqac.dim.turtledb.Engine.addQuery</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>query</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add a query to process. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">query</td><td>The query </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00085">85</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="a75d87c32bedf11ceaaf4aabcaa3d4bb5"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::addQuery" ref="a75d87c32bedf11ceaaf4aabcaa3d4bb5" args="(Collection&lt; Relation &gt; queries)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a69916ef536a8cc50b7963f698324b679">ca.uqac.dim.turtledb.Engine.addQuery</a> </td>
          <td>(</td>
          <td class="paramtype">Collection&lt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a> &gt;&#160;</td>
          <td class="paramname"><em>queries</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Add a set of queries. This is just the repeated application of <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a69916ef536a8cc50b7963f698324b679">addQuery</a> to every element of the collection. </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">queries</td><td>The collection of queries to add </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00149">149</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="ae9740e5e82e1c0a27d2f776d5f94e9c5"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::evaluate" ref="ae9740e5e82e1c0a27d2f776d5f94e9c5" args="(Relation query)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a> <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae9740e5e82e1c0a27d2f776d5f94e9c5">ca.uqac.dim.turtledb.Engine.evaluate</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>query</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Locally evaluates a query </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">query</td><td>The query XML document </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new table containing the results of that query </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00215">215</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="a313f75b83903774366501e0263c583fc"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::evaluate" ref="a313f75b83903774366501e0263c583fc" args="(String s)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a> <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae9740e5e82e1c0a27d2f776d5f94e9c5">ca.uqac.dim.turtledb.Engine.evaluate</a> </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>s</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Locally evaluates a query </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">s</td><td>The query string </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>A new table containing the results of that query </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00240">240</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="a5e51f3ae0cbf374ef1f964e74cb2d165"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::evaluate" ref="a5e51f3ae0cbf374ef1f964e74cb2d165" args="(Document d)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a> <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae9740e5e82e1c0a27d2f776d5f94e9c5">ca.uqac.dim.turtledb.Engine.evaluate</a> </td>
          <td>(</td>
          <td class="paramtype">Document&#160;</td>
          <td class="paramname"><em>d</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00254">254</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="acb1c919eba2627b81af6038737a2e693"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::getQueryPlan" ref="acb1c919eba2627b81af6038737a2e693" args="(Relation query)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_query_plan.html">QueryPlan</a> <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#acb1c919eba2627b81af6038737a2e693">ca.uqac.dim.turtledb.Engine.getQueryPlan</a> </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>query</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Creates a query plan from a given query </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">query</td><td>The query to execute </td></tr>
  </table>
  </dd>
</dl>
<dl class="return"><dt><b>Returns:</b></dt><dd>The query plan </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00204">204</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="afe382772677f32c01e99491546bb92c7"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::getStorageSize" ref="afe382772677f32c01e99491546bb92c7" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#afe382772677f32c01e99491546bb92c7">ca.uqac.dim.turtledb.Engine.getStorageSize</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the total number of tuples hosted locally by this database engine. This can be used, in conjunction with <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a0f1f2a11d6134baab599777810cb8ab3">getTuplesReceived</a>, to compute cost metrics. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of tuples </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00274">274</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="a0f1f2a11d6134baab599777810cb8ab3"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::getTuplesReceived" ref="a0f1f2a11d6134baab599777810cb8ab3" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a0f1f2a11d6134baab599777810cb8ab3">ca.uqac.dim.turtledb.Engine.getTuplesReceived</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Returns the number of tuples this engine received from the outside world. This can be used, in conjunction with <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#afe382772677f32c01e99491546bb92c7">getStorageSize</a>, to compute cost metrics. </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The number of tuples </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00291">291</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="a0875d6d4fa02325381018551d28bbdf4"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::processPendingQueries" ref="a0875d6d4fa02325381018551d28bbdf4" args="()" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Set&lt;<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&gt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a0875d6d4fa02325381018551d28bbdf4">ca.uqac.dim.turtledb.Engine.processPendingQueries</a> </td>
          <td>(</td>
          <td class="paramname"></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Process any pending queries </p>
<dl class="return"><dt><b>Returns:</b></dt><dd>The results of queries that have been processed </dd></dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00159">159</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="ae0151fa00d1f1bd56f1e22a9b4e554b1"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::putRelation" ref="ae0151fa00d1f1bd56f1e22a9b4e554b1" args="(String name, Relation r)" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae0151fa00d1f1bd56f1e22a9b4e554b1">ca.uqac.dim.turtledb.Engine.putRelation</a> </td>
          <td>(</td>
          <td class="paramtype">String&#160;</td>
          <td class="paramname"><em>name</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&#160;</td>
          <td class="paramname"><em>r</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>Stores a new relation within the engine. Normally one would only store instances of <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_table.html">Table</a> here (although any relation can be passed). </p>
<dl class="params"><dt><b>Parameters:</b></dt><dd>
  <table class="params">
    <tr><td class="paramname">name</td><td>The relation's name </td></tr>
    <tr><td class="paramname">r</td><td>The relation </td></tr>
  </table>
  </dd>
</dl>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00076">76</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<hr/><h2>Member Data Documentation</h2>
<a class="anchor" id="a324ad5477ac8645f31483a7e4b493e21"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::m_numTuplesReceived" ref="a324ad5477ac8645f31483a7e4b493e21" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#a324ad5477ac8645f31483a7e4b493e21">ca.uqac.dim.turtledb.Engine.m_numTuplesReceived</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The total number of tuples received by this site </p>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00050">50</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="acd0ede62f32f128788ebece4966a09ea"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::m_pendingQueries" ref="acd0ede62f32f128788ebece4966a09ea" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">List&lt;<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&gt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#acd0ede62f32f128788ebece4966a09ea">ca.uqac.dim.turtledb.Engine.m_pendingQueries</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The list of query plans that await computation </p>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00045">45</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="ae2dbc25a1e13d2b649b58db1420a3c55"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::m_siteName" ref="ae2dbc25a1e13d2b649b58db1420a3c55" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">String <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#ae2dbc25a1e13d2b649b58db1420a3c55">ca.uqac.dim.turtledb.Engine.m_siteName</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">
<p>The site's name </p>

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00055">55</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<a class="anchor" id="abe4f2a3c91bb50dd8eae920fc4f70b7a"></a><!-- doxytag: member="ca::uqac::dim::turtledb::Engine::m_tables" ref="abe4f2a3c91bb50dd8eae920fc4f70b7a" args="" -->
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">Map&lt;String,<a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_relation.html">Relation</a>&gt; <a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html#abe4f2a3c91bb50dd8eae920fc4f70b7a">ca.uqac.dim.turtledb.Engine.m_tables</a><code> [protected]</code></td>
        </tr>
      </table>
</div>
<div class="memdoc">

<p>Definition at line <a class="el" href="_engine_8java_source.html#l00040">40</a> of file <a class="el" href="_engine_8java_source.html">Engine.java</a>.</p>

</div>
</div>
<hr/>The documentation for this class was generated from the following file:<ul>
<li>src/ca/uqac/dim/turtledb/<a class="el" href="_engine_8java_source.html">Engine.java</a></li>
</ul>
</div><!-- contents -->
</div>
  <div id="nav-path" class="navpath">
    <ul>
      <li class="navelem"><a class="el" href="namespaceca.html">ca</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac.html">uqac</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac_1_1dim.html">dim</a>      </li>
      <li class="navelem"><a class="el" href="namespaceca_1_1uqac_1_1dim_1_1turtledb.html">turtledb</a>      </li>
      <li class="navelem"><a class="el" href="classca_1_1uqac_1_1dim_1_1turtledb_1_1_engine.html">Engine</a>      </li>

    <li class="footer">Generated on Fri Dec 7 2012 18:55:40 for TurtleDB by
    <a href="http://www.doxygen.org/index.html">
    <img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.6.1 </li>
   </ul>
 </div>


</body>
</html>
